home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / fish / 751-760 / 753 / mostra / mostra.doc < prev    next >
Text File  |  1995-03-18  |  18KB  |  445 lines

  1.  
  2.  
  3. *
  4.  
  5.    This file describes `Mostra' 1.08, a shareware IFF utility featuring
  6. real-time unpacking scroll, dozens of options, "smart" analysis of any
  7. IFF file (FORMs, LISTs,...  also nested ILBM!), total control over
  8. display modes, simple slideshow processing, pattern matching,
  9. multipalette, double buffering, fast decompression, color cycling,
  10. TeXdocs, startup files for easy custom configurations and complete WB
  11. support.
  12.  
  13.  
  14. Introduction
  15. *************
  16.  
  17.    `Mostra' is an IFF ILBM viewer that can process *any* IFF ILBM file;
  18. this means not only IFF ILBM FORMs, but also nested ILBM, FTXT, FORMs,
  19. CATs, LISTs and PROPs. It has become reknown in the Amiga community for
  20. both its robustness and its flexibility.
  21.  
  22.    Any design requires tradeoffs: `Mostra' tries to give you a good
  23. balance of program size (less than 15K), speed (optimized assembler
  24. decompression routines) and features. It tries to be enough smart to
  25. have always reasonable defaults, but also lets you force any aspect of
  26. the display, such as resolution and video flags. While it is not
  27. possible to foresee every possible race condition, `Mostra' should be
  28. able to cope with any reasonable ILBM file.
  29.  
  30.    `Mostra' currently relies on ARP v39 in order to work. Thus, the
  31. `arp.library' file has to be in your `libs:' directory if you want to
  32. run `Mostra'. Otherwise, a message will be displayed, and `Mostra' will
  33. refuse to run. (Without ARP's powerful functions, `Mostra' would have
  34. never been released.) However, `Mostra' 2.0 will work only under
  35. Release 2 and will not need ARP.
  36.  
  37.    One of the major features in this release is support for
  38. multi-palette pictures, i.e., pictures with the new PCHG chunk which
  39. should substitute the old CTBL and SHAM chunks. See the `Changes.doc'
  40. file for additional informations. SHAM is still supported, but the
  41. support of CTBL pictures via external call has been dropped since it
  42. was shown to be unreliable.
  43.  
  44.  
  45. Syntax
  46. *******
  47.  
  48. `Mostra' can be called both from the CLI and from the Workbench. It is
  49. also a pure program, i.e., it can be made resident.
  50.  
  51.  
  52. Command Line Usage
  53. ===================
  54.  
  55.    To get the command line syntax in AmigaDOS style, type:
  56.      M ?
  57.  
  58. This will produce the input template:
  59.      Files/...,A=All/S,R=Repeat/S,Q=Quiet/S,NoFastDraw/S,
  60.      C=Center/S,B=BlackBackground/S,W=Width/K,H=Height/K,Cycle/S,
  61.      Secs/K,Fade/K,NO=NoStartup/S,Batch/K,LockPic/S,
  62.      N=NoMouse/S,F=FreeMouse/S,LockKeys/S,NA=NoActivate/S,DB=DoubleBuffering/S,
  63.      Hires/S,Lace/S,Lores/S,NoLace/S,HAM/S,Halfbrite/S
  64.  
  65. If you ask for more help by typing `?' again, you will see:
  66.      Mostra 1.08 (C) 1990,1991,1992 Sebastiano Vigna
  67.      Usage: M <wildcards [...] | !> [All] [Repeat] [Quiet] [NoFastDraw]
  68.      [Center] [BlackBackground] [Width n] [Height n] [Cycle]
  69.      [Secs time] [Fade speed] [NoStartup] [Batch file] [LockPic]
  70.      [NoMouse] [FreeMouse] [LockKeys] [NoActivate] [DoubleBuffering]
  71.      [Hires | Lores] [Lace | NoLace] [HAM | Halfbrite]
  72.  
  73. The same help is displayed if you call `Mostra' with no arguments.
  74.  
  75.    `Mostra''s first argument is a list of patterns (or file names) as
  76. long as you want; you will get every picture whose name matches one of
  77. the patterns.
  78.  
  79.    Alternatively, you can type only the `!' character, and `Mostra'
  80. will display the ARP file requester, allowing you to search for the
  81. picture you want to show.
  82.  
  83.  
  84. Workbench Usage
  85. ================
  86.  
  87.    When `Mostra' is called from Workbench without any argument icon, it
  88. will pop the file requester and will allow you to select pictures to
  89. show until you select `Cancel' or close the file requester window.
  90. Alternatively, you can SHIFT-select multiple icons together with
  91. `Mostra''s one, or you can change the default tool of your pictures.
  92. For details about this, see Startup Tool Types. Note that if you select
  93. an IFF CAT or LIST you will have an automatic little slideshow.
  94.  
  95.  
  96. Keyboard Usage
  97. ===============
  98.  
  99.    Once you are looking at the picture you selected, you can exit by
  100. moving the mouse pointer to the very top of the screen and pressing the
  101. right button (you can also press the RETURN, SPACE or ESCAPE keys). You
  102. can drag or depth arrange the screen with the left mouse button (the
  103. gadget(s) are invisible, but they really are there!). TAB will toggle
  104. on/off color cycling. To stop pattern matching or IFF scanning use
  105. `CTRL-C' at any moment.
  106.  
  107.    If the screen size is less than the size of the picture, you can
  108. move around with cursor keys alone (moving by 8 pixels) or in
  109. combination with the SHIFT (a screenful minus 16 pixels), ALT (which
  110. brings you to the borders), or CTRL (16 pixels) keys. A noteworthy
  111. feature of `Mostra' is that the picture is *not* decrunched all at one
  112. time in a very large chunk of memory; instead, a fast LM routine
  113. decrunches the file in real-time every time you move (the routine could
  114. be faster, but it has lots of controls to get rid of damaged IFF BODY
  115. chunks; safety always first). This is not as fast as the memory-eating
  116. method, but I think it's *much* better. Very large pictures (like
  117. 800x900) will be shown in a full screen (generated on the fly at
  118. Workbench size) which you can move around. Overscan pictures will
  119. retain their size of it's not greater than 362x283 lo-res pixels
  120. (362x241 on a NTSC Amiga). For hi-res pictures, there is also a 704
  121. pixel width limit due to Intuition (724 under Release 2). Small brushes
  122. will be shown in a minimum 256x128 pixel screen. Of course, moving
  123. vertically with multi-palette pictures involves a high system overhead,
  124. since Copper lists are continuously built and deleted.
  125.  
  126.    A weird effect of this method is that you can see pictures that
  127. can't even be *loaded* into your Amiga. Let's suppose you have a really
  128. crunched picture; the BODY chunk and a 256x256 lo-res screen could take
  129. much less space than the decrunched picture, so you could create
  130. pictures that only `Mostra' could let you see in all of their parts.
  131. Why you would want to do this, well, that's another matter.
  132.  
  133.  
  134. Options
  135. ========
  136.  
  137.    This list describes all the options available in `Mostra'. The
  138. letters between parentheses denote availability of a shortening.
  139. Options can be put anywhere on the command line, or in Tool Types (see
  140. Startup Tool Types).
  141.  
  142. `All (A)'
  143.      forces a recursive scan of all of the subdirectories during the
  144.      wildcard search.
  145.  
  146. `Repeat (R)'
  147.      will endlessly restart from the first pattern when it has finished
  148.      with the last; if you used the `!' line arguments, the file
  149.      requester will pop up after every picture until you `Cancel' or
  150.      close.
  151.  
  152. `Quiet (Q)'
  153.      turns off all messages except in case of error.
  154.  
  155. `NoFastDraw'
  156.      leaves the program at priority 0; by default, `Mostra' will
  157.      surround the BODY decrunching operations with a `SetTaskPri(1)'.
  158.      This will not lock the system, but in a multitasking situation
  159.      `Mostra' will perform quickly when needed.
  160.  
  161. `Center (C)'
  162.      will force the screen to be centered (640x200 pictures on PAL
  163.      screens look so ugly...) and will use overscan if necessary. Note
  164.      that if you move the screen, and you are not under Release 2, the
  165.      centering will go away.
  166.  
  167. `BlackBackground (B)'
  168.      will create a 0-bitplane black screen that will stay until you saw
  169.      the last picture. This is for aesthetic purposes only (note that
  170.      no Chip memory will be used).
  171.  
  172. `Width (W)'
  173. `Height (H)'
  174.      want an argument that specifies a dimension of the viewing screen.
  175.      However, `Mostra' is an intelligent program, and will almost always
  176.      find the correct screen by itself. *Warning*:  dimensions allowed
  177.      are from 64 to 1024, at your own risk. Your Amiga won't crash, but
  178.      weird things can happen...
  179.  
  180. `Cycle'
  181.      will automatically activate color cycling on every picture.
  182.      Usually this happens only by request, through TAB.
  183.  
  184. `Secs'
  185.      must be followed by a number between 0 and 1000 (the zero delay
  186.      was a request from a BIXen). `Mostra' will display each picture
  187.      for the number of seconds specified, but you can skip using the
  188.      mouse or the keyboard as usual (see Keyboard Usage) or stop the
  189.      show with `CTRL-C'. Cursor keys are disabled. Greatly reworked on
  190.      Warren's request.
  191.  
  192. `Fade'
  193.      lets you specify a speed for pictures to fade in and out. Valid
  194.      numbers are 1 to 4, with four the slowest. Note that HAM pictures
  195.      can't be faded.
  196.  
  197. `NoMouse (N)'
  198.      will hide the mouse pointer while `Mostra' is displaying a picture.
  199.  
  200. `FreeMouse (F)'
  201.      will let you pass from one picture to another by clicking either
  202.      of the mouse buttons at any position on the screen.
  203.  
  204. `LockKeys'
  205.      will discard any input from the keyboard during the display. You
  206.      must use the mouse to pass to the following picture. Note that if
  207.      `FreeMouse' is not activated, the only way to go is clicking the
  208.      right mouse button while the mouse pointer is at the top of the
  209.      screen.
  210.  
  211. `LockPic'
  212.      will lock the picture displayed. You won't be able to scroll
  213.      around, but the memory in which the file is loaded will be
  214.      immediately freed after the decompression, thus minimizing the
  215.      memory usage.
  216.  
  217. `NoActivate (NA)'
  218.      will inhibit the activation of the picture screens, so you can
  219.      keep on typing on your current screen. This was a request from Tom.
  220.  
  221. `DoubleBuffering (DB)'
  222.      sets a double buffering show mode:  while a new picture is being
  223.      loaded you will see the old one, no Workbench pop-up or black
  224.      screens. It eats lots of memory, too. Again, a request from Tom.
  225.      (Note:  it's canceled if you call the file requester.)
  226.  
  227. `Hires'
  228. `Lores'
  229. `Lace'
  230. `NoLace'
  231. `HAM'
  232. `HalfBrite'
  233.      force all screens to be in the respective mode (note that if
  234.      `Mostra' finds a six bitplane picture with no CAMG chunk, it won't
  235.      set the `HAM' flag by default). These flags are dumb, that is,
  236.      they will do exactly what you say, even if it is meaningless.
  237.      However, if you use both `HalfBrite' and `HAM' together, only the
  238.      former will take place.
  239.  
  240.    The `NoStartup' and `Batch' options will be discussed later, in
  241. Startup Files.
  242.  
  243.  
  244. Examples
  245. =========
  246.  
  247.    And now, some examples:
  248.  
  249.      M MyPics:* Secs 5 Fade 1 NoMouse BlackBackground Repeat Center All
  250.  
  251. will generate a slide show of the pictures in the `MyPics:' directory
  252. and in all its subdirectories, centered and with no mouse pointer
  253. hanging around. In order to stop the slide show, you must press
  254. `CTRL-C'.
  255.  
  256.      M df0:*.image df0:pictures/*.pic Hires Lace
  257.  
  258. will show the files ending with `.image' in the directory `df0:' and
  259. the files ending with `.pic' in the directory `df0:pictures'. `Mostra'
  260. will be forced to use high resolution, interlaced screens. Setting the
  261. `Hires' flag on pictures with more than 4 bitplanes usually leads you
  262. to see absolutely nothing.
  263.  
  264.      M dh0:hirespic Lores NoLace
  265.  
  266. will show a hi-res picture in lo-res ("zooming in"). You can move
  267. around with the cursor keys as described above.
  268.  
  269.    `Width' and `Height' can be useful when you have a picture that
  270. cannot be displayed because there's not enough Chip RAM (you get the
  271. `Can't open Screen' error message). In such a case, try:
  272.  
  273.      M pic Width 128 Height 128
  274.  
  275. This will usually allow you to at least get a peek at something.
  276.  
  277.  
  278. Advanced Features
  279. ******************
  280.  
  281.    For maximum flexibility, `Mostra' allows you to use "startup files"
  282. and "startup Tool Types", with which you can configure the program to
  283. suit your tastes.
  284.  
  285.  
  286. Startup Files
  287. ==============
  288.  
  289.    There is a standard startup file, called `S:Startup-Mostra'.
  290. `Mostra' will search for it when run from the CLI. The format of this
  291. file is *exactly* the same as the `Mostra''s line format minus the
  292. command name. Commands may be spread out over several lines or gathered
  293. together onto a single line. Every switch or keyword in the startup file
  294. will act as a default, and will be toggled or superseded by any command
  295. line arguments. Command line switches will act as toggles (if your
  296. startup file has the keyword `All' and you say `M * All', you *won't* go
  297. into subdirectories), while keywords simply assert the new value (if you
  298. have `Fade 1' in your startup file and you say `Fade 3' in the command
  299. line, your pictures will be faded at speed 3).
  300.  
  301.    Two options concern startup files:
  302.  
  303. `NoStartup (NO)'
  304.      inhibits the search for startup files, useful if you have one and
  305.      you want to specify your options from scratch.
  306.  
  307. `Batch'
  308.      wants a complete path/filename that `Mostra' will use as startup
  309.      file.
  310.  
  311.  
  312. Startup Tool Types
  313. ===================
  314.  
  315.    From the Workbench side, you can write the startup options in the
  316. Tool Types of `Mostra''s icon, and it will use them. The format is the
  317. same of `Startup-Mostra'. Please note that `Fade=1', `Width=352' are
  318. valid, but `FreeMouse=ON' is not; use only `FreeMouse'.
  319.  
  320.    Or you can set the first Tool Type of a project icon to `STARTUP' and
  321. put your options in the following lines; the project picture file will
  322. be shown with those options when you double-click its icon. You can do
  323. the same thing with an icon that has no related file, and put some
  324. wildcards in the Tool Type. The wildcards will then be shown with those
  325. options. If you don't put in wildcards, you get a "style" icon;  you can
  326. SHIFT-click some icons, `SHIFT'-click the "style" icon (in *this*
  327. order) and then SHIFT-double-click `Mostra''s icon (or directly
  328. SHIFT-double-click the last icon, if its default tool is `Mostra'): 
  329. you will see the selected picture files with the options specified in
  330. the style icon. The style icon by itself will pop up the file
  331. requester. Please note that even an icon with wildcards can be used as a
  332. style icon because multiple selections supersede wildcards.
  333.  
  334.    I know, it seems a little twisted, but using it you'll find,
  335. instead, that it's the way you'd think.
  336.  
  337.    *Warning*:  strange interactions can take place. If you have some
  338. picture icons, and you SHIFT-click all but one of them and then you
  339. SHIFT-double-click the last one *and* the last picture icon you clicked
  340. had some `STARTUP' options, you will see *all* of the pictures with
  341. those options. Right?
  342.  
  343.    For curious/tech/interested people, here is the exact algorithm:
  344.  
  345.   1. If `sm_NumArgs>1' (the user started `Mostra' with al least an icon
  346.      argument), check if `sm_ArgList[1]' (the first real argument) has
  347.      Tool Types with first Tool Type `STARTUP'. If so, scan the whole
  348.      Tool Types list like a command line, accepting mixed commands on a
  349.      single Tool Type as well as separated commands in separated Tool
  350.      Types.
  351.  
  352.   2. If the first step goes wrong, check the `Mostra' icon Tool Types,
  353.      and take them as a command line. (Note:  `STARTUP' is not
  354.      requested.)
  355.  
  356.   3. Now, if `sm_NumArgs>1', check every `sm_ArgList[i]' with `i>0' and
  357.      if there is a related file (*not* a `.info' file!) generate a list
  358.      of arguments as if the user entered them manually, *superseding*
  359.      eventual filenames/wildcards found in the previous steps.
  360.  
  361.  
  362. Startup Examples
  363. =================
  364.  
  365.    Now, examples, by means of common problems:
  366.  
  367.    * "I have a hundred pictures on my 360M hard disk, and I've organized
  368.      them in a few groups. How can I make simple slideshows, with each
  369.      group separate?"
  370.  
  371.      Simple: create a project icon for each group, and add a Tool Type
  372.      `STARTUP'. Then add a Tool Type like `PICS:Group1/* All Secs 5
  373.      Center' to choose your options, set the default tool to `C:M' (or
  374.      wherever you put it) and double-click (of course, this must be
  375.      done with every group icon). Don't give the icons the same name as
  376.      a directory, or `Mostra' will collapse in confusion.
  377.  
  378.    * "I want to always see the black screen when I start from WB."
  379.  
  380.      Set a `Mostra' Tool Type to `BlackBackground'.
  381.  
  382.    * "I have some pictures. Sometimes I want to see a few of them with a
  383.      full screen and no mouse, sometimes with a 128x128 screen,
  384.      sometimes centered."
  385.  
  386.      Create three "style" icons. Each icon must have as its first Tool
  387.      Type `STARTUP', and the following ones must be something like
  388.      `NoMouse', `Width 128 Height 128' and `Center'. The default tool
  389.      must be `C:M'. When you want to see in a certain style,
  390.      `SHIFT'-click the picture icons and *then* `SHIFT'-double-click
  391.      the style icon you desire.
  392.  
  393.    * "I like to click my pics one at a time, each one with different
  394.      options. I'd like also to see them in irregular groups, each
  395.      picture with its options."
  396.  
  397.      You need a psycho-analyst, not `Mostra'.
  398.  
  399.  
  400. Acknowledgments
  401. ****************
  402.  
  403.    I wish to thank some people, first of all the ARP team for the
  404. arp.library and the SAS team for the best Amiga C compiler. Speed and
  405. compactness of `Mostra' come from the fabulous 5.10b release. Also I
  406. would like to thank the people that encouraged me someway or helped me
  407. to find bugs, in particular Warren Block, Tom Rokicki, Christopher A.
  408. Wichura and Loren Wilton.
  409.  
  410.    If you're reading this, you probably have access to a TeX system.
  411. Anyway, if you spent a good part of your time preparing and printing
  412. documents, I'd suggest you to take a look at AmigaTeX, a wonderful
  413. package from Radical Eye Software which is probably the best
  414. implementation of TeX you can find on any computer.
  415.  
  416.    `Mostra' is (C) 1990,1991,1992 Sebastiano Vigna and it's not public
  417. domain: it is shareware. You should send me $20 (or more, why not?) if
  418. you find it useful. Please don't send checks drawn on a US bank, they're
  419. almost impossible to cash. I'd prefer postal money orders, currency or
  420. checks drawn on an italian bank (in this order). `Mostra'  is freely
  421. distributable as long as all of its files are included in their original
  422. form without additions, deletions, or modifications of any kind, and
  423. only a nominal fee is charged for its distribution. This software is
  424. provided "AS IS" without warranty of any kind, either expressed or
  425. implied. By using `Mostra', you agree to accept the entire risk as to
  426. the quality and performance of the program.
  427.  
  428.    Comments, complaints, desiderata are welcome.
  429.  
  430.  
  431. Author Info
  432. ************
  433.  
  434.          Sebastiano Vigna
  435.          Via California 22
  436.          I-20144 Milano MI
  437.      
  438.          BIX: svigna
  439.          INTERNET: vigna@imiucca.csi.unimi.it
  440.                    vigna@ghost.sm.dsi.unimi.it
  441.          UUCP:cbmehq!cbmita!sebamiga!seba@cbmvax.cbm.commodore.com
  442.               ...{uunet|pyramid|rutgers}!cbmvax!cbmehq!cbmita!sebamiga!seba
  443.          FIDO: 2:332/607.28
  444.  
  445.